<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module wxi</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>

<h1>Module wxi</h1>
<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>

<p><b>Version:</b> 0.1</p>
<p><b>Authors:</b> Dmitry Golubovsky (<a href="mailto:golubovsky@gmail.com"><tt>golubovsky@gmail.com</tt></a>).</p>

<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#addSelf-2">addSelf/2</a></td><td>Add the wx widget to its parent wrt parent's sizer.</td></tr>
<tr><td valign="top"><a href="#addSelf-3">addSelf/3</a></td><td>Add the wx widget to its parent wrt parent's sizer with sizer flags explicitly
  specified.</td></tr>
<tr><td valign="top"><a href="#always-0">always/0</a></td><td>Always pass any event received unchanged.</td></tr>
<tr><td valign="top"><a href="#button-2">button/2</a></td><td>Create a button with given label and numeric ID.</td></tr>
<tr><td valign="top"><a href="#catchEvents-1">catchEvents/1</a></td><td>Connect the parent to the list of events.</td></tr>
<tr><td valign="top"><a href="#catchEvents-2">catchEvents/2</a></td><td>Connect the parent to the list of events explicitly setting parent window Id.</td></tr>
<tr><td valign="top"><a href="#comp-2">comp/2</a></td><td>Compose a subordinate piece of GUI.</td></tr>
<tr><td valign="top"><a href="#grid-2">grid/2</a></td><td>Create a panel with GridSizer.</td></tr>
<tr><td valign="top"><a href="#linkEvent-3">linkEvent/3</a></td><td>Form a function which will pass events generated by this widget to its event link.</td></tr>
<tr><td valign="top"><a href="#map-1">map/1</a></td><td>Apply the given function to any event received, and send the result to the event link.</td></tr>
<tr><td valign="top"><a href="#mapState-2">mapState/2</a></td><td>Apply the given function fo any event received and the encapsulated state.</td></tr>
<tr><td valign="top"><a href="#maybe-1">maybe/1</a></td><td>Apply the given function to any event received, but pass the event to the event
  if the function returns a tuple {'just', E} where E is the value to be passed.</td></tr>
<tr><td valign="top"><a href="#modSizerFlags-2">modSizerFlags/2</a></td><td>Modify sizer flags in the context.</td></tr>
<tr><td valign="top"><a href="#never-0">never/0</a></td><td>Never pass any event.</td></tr>
<tr><td valign="top"><a href="#panel-1">panel/1</a></td><td>Create a panel without sizer.</td></tr>
<tr><td valign="top"><a href="#panel-2">panel/2</a></td><td>Create a panel (box) with given sizer orientation (either vertical or horizontal;
  wxBoxSizer will be used).</td></tr>
<tr><td valign="top"><a href="#passEvent-2">passEvent/2</a></td><td>Pass an event to the event link for this widget.</td></tr>
<tr><td valign="top"><a href="#rcomp-2">rcomp/2</a></td><td>Same as comp/2, but placement is reversed.</td></tr>
<tr><td valign="top"><a href="#textLabel-2">textLabel/2</a></td><td>Create a text label that can be updated.</td></tr>
<tr><td valign="top"><a href="#topFrame-5">topFrame/5</a></td><td>Create a toplevel frame (window) with given title, dimensions, and sizer
  orientation (either vertical or horizontal; wxBoxSizer will be used).</td></tr>
</table>

<h2><a name="functions">Function Details</a></h2>

<h3 class="function"><a name="addSelf-2">addSelf/2</a></h3>
<div class="spec">
<p><tt>addSelf(P, W) -&gt; any()</tt></p>
</div><p>Add the wx widget to its parent wrt parent's sizer.</p>

<h3 class="function"><a name="addSelf-3">addSelf/3</a></h3>
<div class="spec">
<p><tt>addSelf(P, W, F) -&gt; any()</tt></p>
</div><p>Add the wx widget to its parent wrt parent's sizer with sizer flags explicitly
  specified.</p>

<h3 class="function"><a name="always-0">always/0</a></h3>
<div class="spec">
<p><tt>always() -&gt; any()</tt></p>
</div><p>Always pass any event received unchanged.</p>

<h3 class="function"><a name="button-2">button/2</a></h3>
<div class="spec">
<p><tt>button(T, I) -&gt; any()</tt></p>
</div><p>Create a button with given label and numeric ID. Mouse clicks on the button
  will cause a <tt>command_button_clicked</tt> message to be passed to its event link.</p>

<h3 class="function"><a name="catchEvents-1">catchEvents/1</a></h3>
<div class="spec">
<p><tt>catchEvents(Es) -&gt; any()</tt></p>
</div><p>Connect the parent to the list of events.</p>

<h3 class="function"><a name="catchEvents-2">catchEvents/2</a></h3>
<div class="spec">
<p><tt>catchEvents(Es, Id) -&gt; any()</tt></p>
</div><p>Connect the parent to the list of events explicitly setting parent window Id.
  This may be useful when setting events capture for a panel which was created
  without window Id specified.</p>

<h3 class="function"><a name="comp-2">comp/2</a></h3>
<div class="spec">
<p><tt>comp(Sub, C) -&gt; any()</tt></p>
</div><p>Compose a subordinate piece of GUI. List of widgets encodes parallel composition,
  tuple of widgets encodes sequential composition. This function is intended to be called
  from within the creation phase code of a widget having subordinates (e. g. panel).</p>

<h3 class="function"><a name="grid-2">grid/2</a></h3>
<div class="spec">
<p><tt>grid(Cols, Sub) -&gt; any()</tt></p>
</div><p>Create a panel with GridSizer. Number of columns
  is specified upon creation; rows are added automatically
  as children are added. This widget does not allow reverse
  placement of its subordinates.</p>

<h3 class="function"><a name="linkEvent-3">linkEvent/3</a></h3>
<div class="spec">
<p><tt>linkEvent(Src, Dst, Evts) -&gt; any()</tt></p>
</div><p>Form a function which will pass events generated by this widget to its event link.</p>

<h3 class="function"><a name="map-1">map/1</a></h3>
<div class="spec">
<p><tt>map(F) -&gt; any()</tt></p>
</div><p>Apply the given function to any event received, and send the result to the event link.</p>

<h3 class="function"><a name="mapState-2">mapState/2</a></h3>
<div class="spec">
<p><tt>mapState(F, S) -&gt; any()</tt></p>
</div><p>Apply the given function fo any event received and the encapsulated state.
  The widget keeps the state between messages. The value returned from the function
  will be sent to the event link of this widget.</p>

<h3 class="function"><a name="maybe-1">maybe/1</a></h3>
<div class="spec">
<p><tt>maybe(F) -&gt; any()</tt></p>
</div><p>Apply the given function to any event received, but pass the event to the event
  if the function returns a tuple {'just', E} where E is the value to be passed.</p>

<h3 class="function"><a name="modSizerFlags-2">modSizerFlags/2</a></h3>
<div class="spec">
<p><tt>modSizerFlags(F, Sub) -&gt; any()</tt></p>
</div><p>Modify sizer flags in the context. All subordinate widgets will use the modified
  context. This widget only allows normal order of subordinates placement although
  orientation is inherited from the parent.</p>

<h3 class="function"><a name="never-0">never/0</a></h3>
<div class="spec">
<p><tt>never() -&gt; any()</tt></p>
</div><p>Never pass any event.</p>

<h3 class="function"><a name="panel-1">panel/1</a></h3>
<div class="spec">
<p><tt>panel(Sub) -&gt; any()</tt></p>
</div><p>Create a panel without sizer.</p>

<h3 class="function"><a name="panel-2">panel/2</a></h3>
<div class="spec">
<p><tt>panel(Dir, Sub) -&gt; any()</tt></p>
</div><p>Create a panel (box) with given sizer orientation (either vertical or horizontal;
  wxBoxSizer will be used). This widget honors the sign of the orientation flag: negative
  values cause reverse order of placement (right to left for <tt>?wxHORIZONTAL</tt>,
  and bottom to top for <tt>?wxVERTICAL</tt>).</p>

<h3 class="function"><a name="passEvent-2">passEvent/2</a></h3>
<div class="spec">
<p><tt>passEvent(R, D) -&gt; any()</tt></p>
</div><p>Pass an event to the event link for this widget.</p>

<h3 class="function"><a name="rcomp-2">rcomp/2</a></h3>
<div class="spec">
<p><tt>rcomp(Sub, C) -&gt; any()</tt></p>
</div><p>Same as comp/2, but placement is reversed.</p>

<h3 class="function"><a name="textLabel-2">textLabel/2</a></h3>
<div class="spec">
<p><tt>textLabel(Fmt, T) -&gt; any()</tt></p>
</div><p>Create a text label that can be updated. Any event received will be formatted
  as specified by the first argument and displayed. The second argument specifies the
  initial text displayed.</p>

<h3 class="function"><a name="topFrame-5">topFrame/5</a></h3>
<div class="spec">
<p><tt>topFrame(Title, X, Y, Dir, Sub) -&gt; any()</tt></p>
</div><p>Create a toplevel frame (window) with given title, dimensions, and sizer
  orientation (either vertical or horizontal; wxBoxSizer will be used). This widget honors
  the sign of the orientation flag: negative values cause reverse order of placement
  (right to left for <tt>?wxHORIZONTAL</tt>, and bottom to top for <tt>?wxVERTICAL</tt>).</p>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Apr 8 2010, 06:36:26.</i></p>
</body>
</html>
